/*
 * Copyright 2012-2013 Eligotech BV.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.eligosource.eventsourced.journal.common

import akka.actor._

import org.eligosource.eventsourced.core.actor

/**
 * Journal configuration object.
 */
trait JournalProps {
  /**
   * Optional journal name.
   */
  def name: Option[String]

  /**
   * Optional dispatcher name.
   */
  def dispatcherName: Option[String]

  /**
   * Creates and starts a new journal using the settings of this configuration object.
   */
  def createJournal(implicit actorRefFactory: ActorRefFactory): ActorRef = {
    val journalRef = actor(createJournalActor, name, dispatcherName)
    if(readOnly)
      actor(new ReadOnlyFacade(journalRef))
    else
      journalRef
  }

  /**
   * Creates a journal actor instance.
   */
  protected def createJournalActor: Actor

  /**
   * Make journal read only (e.g. offline snapshot)
   */
  def readOnly: Boolean
}
